Filter hook 'default_{$meta_type}_metadata'

in WP Core File wp-includes/meta.php at line 729

View Source

default_{$meta_type}_metadata

Filter Hook
Description
Filters the default metadata value for a specified meta key and object. The dynamic portion of the hook name, `$meta_type`, refers to the meta object type (post, comment, term, user, or any other type with an associated meta table). Possible filter names include: - `default_post_metadata` - `default_comment_metadata` - `default_term_metadata` - `default_user_metadata`

Hook Information

File Location wp-includes/meta.php View on GitHub
Hook Type Filter
Line Number 729

Hook Parameters

Type Name Description
mixed $value The value to return, either a single metadata value or an array of values depending on the value of `$single`.
int $object_id ID of the object metadata is for.
string $meta_key Metadata key.
bool $single Whether to return only the first value of the specified `$meta_key`.
string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.

Usage Examples

Basic Usage
<?php
// Hook into default_{$meta_type}_metadata
add_filter('default_{$meta_type}_metadata', 'my_custom_filter', 10, 5);

function my_custom_filter($value, $object_id, $meta_key, $single, $meta_type) {
    // Your custom filtering logic here
    return $value;
}

Source Code Context

wp-includes/meta.php:729 - How this hook is used in WordPress core
<?php
 724  	 * @param string $meta_key  Metadata key.
 725  	 * @param bool   $single    Whether to return only the first value of the specified `$meta_key`.
 726  	 * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
 727  	 *                          or any other object type with an associated meta table.
 728  	 */
 729  	$value = apply_filters( "default_{$meta_type}_metadata", $value, $object_id, $meta_key, $single, $meta_type );
 730  
 731  	if ( ! $single && ! wp_is_numeric_array( $value ) ) {
 732  		$value = array( $value );
 733  	}
 734  

PHP Documentation

<?php
/**
	 * Filters the default metadata value for a specified meta key and object.
	 *
	 * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
	 * (post, comment, term, user, or any other type with an associated meta table).
	 *
	 * Possible filter names include:
	 *
	 *  - `default_post_metadata`
	 *  - `default_comment_metadata`
	 *  - `default_term_metadata`
	 *  - `default_user_metadata`
	 *
	 * @since 5.5.0
	 *
	 * @param mixed  $value     The value to return, either a single metadata value or an array
	 *                          of values depending on the value of `$single`.
	 * @param int    $object_id ID of the object metadata is for.
	 * @param string $meta_key  Metadata key.
	 * @param bool   $single    Whether to return only the first value of the specified `$meta_key`.
	 * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
	 *                          or any other object type with an associated meta table.
	 */
Quick Info
  • Hook Type: Filter
  • Parameters: 5
  • File: wp-includes/meta.php
Related Hooks

Related hooks will be displayed here in future updates.